home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / opt / pinstaller / dialog.py < prev    next >
Text File  |  2005-06-28  |  55KB  |  1,569 lines

  1. # dialog.py --- A python interface to the Linux "dialog" utility
  2. # Copyright (C) 2000  Robb Shecter, Sultanbek Tezadov
  3. # Copyright (C) 2002, 2003, 2004  Florent Rougon
  4. # Copyright(C) 2005 Gentoo Linux Installer Project
  5. #
  6. # This library is free software; you can redistribute it and/or
  7. # modify it under the terms of the GNU Lesser General Public
  8. # License as published by the Free Software Foundation; either
  9. # version 2.1 of the License, or (at your option) any later version.
  10. #
  11. # This library is distributed in the hope that it will be useful,
  12. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14. # Lesser General Public License for more details.
  15. #
  16. # You should have received a copy of the GNU Lesser General Public
  17. # License along with this library; if not, write to the Free Software
  18. # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19.  
  20. """Python interface to dialog-like programs.
  21.  
  22. This module provides a Python interface to dialog-like programs such
  23. as `dialog', `Xdialog' and `whiptail'.
  24.  
  25. It provides a Dialog class that retains some parameters such as the
  26. program name and path as well as the values to pass as DIALOG*
  27. environment variables to the chosen program.
  28.  
  29. For a quick start, you should look at the demo.py file that comes
  30. with pythondialog. It demonstrates a simple use of each widget
  31. offered by the Dialog class.
  32.  
  33. See the Dialog class documentation for general usage information,
  34. list of available widgets and ways to pass options to dialog.
  35.  
  36.  
  37. Notable exceptions
  38. ------------------
  39.  
  40. Here is the hierarchy of notable exceptions raised by this module:
  41.  
  42.   error
  43.      ExecutableNotFound
  44.      BadPythonDialogUsage
  45.      PythonDialogSystemError
  46.         PythonDialogIOError
  47.         PythonDialogOSError
  48.         PythonDialogErrorBeforeExecInChildProcess
  49.         PythonDialogReModuleError
  50.      UnexpectedDialogOutput
  51.      DialogTerminatedBySignal
  52.      DialogError
  53.      UnableToCreateTemporaryDirectory
  54.      PythonDialogBug
  55.      ProbablyPythonBug
  56.  
  57. As you can see, every exception `exc' among them verifies:
  58.  
  59.   issubclass(exc, error)
  60.  
  61. so if you don't need fine-grained error handling, simply catch
  62. `error' (which will probably be accessible as dialog.error from your
  63. program) and you should be safe.
  64.  
  65. """
  66.  
  67. from __future__ import nested_scopes
  68. import sys, os, tempfile, random, string, re, types, exceptions
  69.  
  70. # Python < 2.3 compatibility
  71. if sys.hexversion < 0x02030000:
  72.     # The assignments would work with Python >= 2.3 but then, pydoc
  73.     # shows them in the DATA section of the module...
  74.     True = 0 == 0
  75.     False = 0 == 1
  76.  
  77.  
  78. # Exceptions raised by this module
  79. #
  80. # When adding, suppressing, renaming exceptions or changing their
  81. # hierarchy, don't forget to update the module's docstring.
  82. class error(Exception):
  83.     """Base class for exceptions in pythondialog."""
  84.     def __init__(self, message=None):
  85.         exceptions.Exception.__init__(self)
  86.         self.message = message
  87.     def __str__(self):
  88.         return "<%s: %s>" % (self.__class__.__name__, self.message)
  89.     def complete_message(self):
  90.         if self.message:
  91.             return "%s: %s" % (self.ExceptionShortDescription, self.message)
  92.         else:
  93.             return "%s" % self.ExceptionShortDescription
  94.     ExceptionShortDescription = "pythondialog generic exception"
  95.  
  96. # For backward-compatibility
  97. #
  98. # Note: this exception was not documented (only the specific ones were), so
  99. #       the backward-compatibility binding could be removed relatively easily.
  100. PythonDialogException = error
  101.  
  102. class ExecutableNotFound(error):
  103.     """Exception raised when the dialog executable can't be found."""
  104.     ExceptionShortDescription = "Executable not found"
  105.  
  106. class PythonDialogBug(error):
  107.     """Exception raised when pythondialog finds a bug in his own code."""
  108.     ExceptionShortDescription = "Bug in pythondialog"
  109.  
  110. # Yeah, the "Probably" makes it look a bit ugly, but:
  111. #   - this is more accurate
  112. #   - this avoids a potential clash with an eventual PythonBug built-in
  113. #     exception in the Python interpreter...
  114. class ProbablyPythonBug(error):
  115.     """Exception raised when pythondialog behaves in a way that seems to indicate a Python bug."""
  116.     ExceptionShortDescription = "Bug in python, probably"
  117.  
  118. class BadPythonDialogUsage(error):
  119.     """Exception raised when pythondialog is used in an incorrect way."""
  120.     ExceptionShortDescription = "Invalid use of pythondialog"
  121.  
  122. class PythonDialogSystemError(error):
  123.     """Exception raised when pythondialog cannot perform a "system operation" (e.g., a system call) that should work in "normal" situations.
  124.  
  125.     This is a convenience exception: PythonDialogIOError, PythonDialogOSError
  126.     and PythonDialogErrorBeforeExecInChildProcess all derive from this
  127.     exception. As a consequence, watching for PythonDialogSystemError instead
  128.     of the aformentioned exceptions is enough if you don't need precise
  129.     details about these kinds of errors.
  130.  
  131.     Don't confuse this exception with Python's builtin SystemError
  132.     exception.
  133.  
  134.     """
  135.     ExceptionShortDescription = "System error"
  136.     
  137. class PythonDialogIOError(PythonDialogSystemError):
  138.     """Exception raised when pythondialog catches an IOError exception that should be passed to the calling program."""
  139.     ExceptionShortDescription = "IO error"
  140.  
  141. class PythonDialogOSError(PythonDialogSystemError):
  142.     """Exception raised when pythondialog catches an OSError exception that should be passed to the calling program."""
  143.     ExceptionShortDescription = "OS error"
  144.  
  145. class PythonDialogErrorBeforeExecInChildProcess(PythonDialogSystemError):
  146.     """Exception raised when an exception is caught in a child process before the exec sytem call (included).
  147.  
  148.     This can happen in uncomfortable situations like when the system is out
  149.     of memory or when the maximum number of open file descriptors has been
  150.     reached. This can also happen if the dialog-like program was removed
  151.     (or if it is has been made non-executable) between the time we found it
  152.     with _find_in_path and the time the exec system call attempted to
  153.     execute it...
  154.  
  155.     """
  156.     ExceptionShortDescription = "Error in a child process before the exec " \
  157.                                 "system call"
  158.  
  159. class PythonDialogReModuleError(PythonDialogSystemError):
  160.     """Exception raised when pythondialog catches a re.error exception."""
  161.     ExceptionShortDescription = "'re' module error"
  162.  
  163. class UnexpectedDialogOutput(error):
  164.     """Exception raised when the dialog-like program returns something not expected by pythondialog."""
  165.     ExceptionShortDescription = "Unexpected dialog output"
  166.  
  167. class DialogTerminatedBySignal(error):
  168.     """Exception raised when the dialog-like program is terminated by a signal."""
  169.     ExceptionShortDescription = "dialog-like terminated by a signal"
  170.  
  171. class DialogError(error):
  172.     """Exception raised when the dialog-like program exits with the code indicating an error."""
  173.     ExceptionShortDescription = "dialog-like terminated due to an error"
  174.  
  175. class UnableToCreateTemporaryDirectory(error):
  176.     """Exception raised when we cannot create a temporary directory."""
  177.     ExceptionShortDescription = "unable to create a temporary directory"
  178.  
  179. # Values accepted for checklists
  180. try:
  181.     _on_rec = re.compile(r"on", re.IGNORECASE)
  182.     _off_rec = re.compile(r"off", re.IGNORECASE)
  183.  
  184.     _calendar_date_rec = re.compile(
  185.         r"(?P<day>\d\d)/(?P<month>\d\d)/(?P<year>\d\d\d\d)$")
  186.     _timebox_time_rec = re.compile(
  187.         r"(?P<hour>\d\d):(?P<minute>\d\d):(?P<second>\d\d)$")
  188. except re.error, v:
  189.     raise PythonDialogReModuleError(v)
  190.  
  191.  
  192. # This dictionary allows us to write the dialog common options in a Pythonic
  193. # way (e.g. dialog_instance.checklist(args, ..., title="Foo", no_shadow=1)).
  194. #
  195. # Options such as --separate-output should obviously not be set by the user
  196. # since they affect the parsing of dialog's output:
  197. _common_args_syntax = {
  198.     "aspect": lambda ratio: ("--aspect", str(ratio)),
  199.     "backtitle": lambda backtitle: ("--backtitle", backtitle),
  200.     "beep": lambda enable: _simple_option("--beep", enable),
  201.     "beep_after": lambda enable: _simple_option("--beep-after", enable),
  202.     # Warning: order = y, x!
  203.     "begin": lambda coords: ("--begin", str(coords[0]), str(coords[1])),
  204.     "cancel": lambda string: ("--cancel-label", string),
  205.     "clear": lambda enable: _simple_option("--clear", enable),
  206.     "cr_wrap": lambda enable: _simple_option("--cr-wrap", enable),
  207.     "create_rc": lambda file: ("--create-rc", file),
  208.     "defaultno": lambda enable: _simple_option("--defaultno", enable),
  209.     "default_item": lambda string: ("--default-item", string),
  210.     "form": lambda string: ("--form",string),
  211.     "help": lambda enable: _simple_option("--help", enable),
  212.     "help_button": lambda enable: _simple_option("--help-button", enable),
  213.     "help_label": lambda string: ("--help-label", string),
  214.     "ignore": lambda enable: _simple_option("--ignore", enable),
  215.     "item_help": lambda enable: _simple_option("--item-help", enable),
  216.     "max_input": lambda size: ("--max-input", str(size)),
  217.     "no_kill": lambda enable: _simple_option("--no-kill", enable),
  218.     "no_cancel": lambda enable: _simple_option("--no-cancel", enable),
  219.     "nocancel": lambda enable: _simple_option("--nocancel", enable),
  220.     "no_shadow": lambda enable: _simple_option("--no-shadow", enable),
  221.     "ok_label": lambda string: ("--ok-label", string),
  222.     "print_maxsize": lambda enable: _simple_option("--print-maxsize", enable),
  223.     "print_size": lambda enable: _simple_option("--print-size", enable),
  224.     "print_version": lambda enable: _simple_option("--print-version", enable),
  225.     "separate_output": lambda enable: _simple_option("--separate-output",enable),
  226.     "separate_widget": lambda string: ("--separate-widget", string),
  227.     "shadow": lambda enable: _simple_option("--shadow", enable),
  228.     "size_err": lambda enable: _simple_option("--size-err", enable),
  229.     "sleep": lambda secs: ("--sleep", str(secs)),
  230.     "stderr": lambda enable: _simple_option("--stderr", enable),
  231.     "stdout": lambda enable: _simple_option("--stdout", enable),
  232.     "tab_correct": lambda enable: _simple_option("--tab-correct", enable),
  233.     "tab_len": lambda n: ("--tab-len", str(n)),
  234.     "timeout": lambda secs: ("--timeout", str(secs)),
  235.     "title": lambda title: ("--title", title),
  236.     "trim": lambda enable: _simple_option("--trim", enable),
  237.     "version": lambda enable: _simple_option("--version", enable)}
  238.     
  239.  
  240. def _simple_option(option, enable):
  241.     """Turn on or off the simplest dialog Common Options."""
  242.     if enable:
  243.         return (option,)
  244.     else:
  245.         # This will not add any argument to the command line
  246.         return ()
  247.  
  248.  
  249. def _find_in_path(prog_name):
  250.     """Search an executable in the PATH.
  251.  
  252.     If PATH is not defined, the default path ":/bin:/usr/bin" is
  253.     used.
  254.  
  255.     Return a path to the file or None if no readable and executable
  256.     file is found.
  257.  
  258.     Notable exception: PythonDialogOSError
  259.  
  260.     """
  261.     try:
  262.         # Note that the leading empty component in the default value for PATH
  263.         # could lead to the returned path not being absolute.
  264.         PATH = os.getenv("PATH", ":/bin:/usr/bin") # see the execvp(3) man page
  265.         for r_dir in string.split(PATH, ":"):
  266.             file_path = os.path.join(r_dir, prog_name)
  267.             if os.path.isfile(file_path) and os.access(file_path, os.R_OK | os.X_OK):
  268.                 return file_path
  269.         return None
  270.     except os.error, v:
  271.         raise PythonDialogOSError(v.strerror)
  272.  
  273.  
  274. def _path_to_executable(f):
  275.     """Find a path to an executable.
  276.  
  277.     Find a path to an executable, using the same rules as the POSIX
  278.     exec*p functions (see execvp(3) for instance).
  279.  
  280.     If `f' contains a '/', it is assumed to be a path and is simply
  281.     checked for read and write permissions; otherwise, it is looked
  282.     for according to the contents of the PATH environment variable,
  283.     which defaults to ":/bin:/usr/bin" if unset.
  284.  
  285.     The returned path is not necessarily absolute.
  286.  
  287.     Notable exceptions:
  288.  
  289.         ExecutableNotFound
  290.         PythonDialogOSError
  291.         
  292.     """
  293.     try:
  294.         if '/' in f:
  295.             if os.path.isfile(f) and os.access(f, os.R_OK | os.X_OK):
  296.                 res = f
  297.             else:
  298.                 raise ExecutableNotFound("%s cannot be read and executed" % f)
  299.         else:
  300.             res = _find_in_path(f)
  301.             if res is None:
  302.                 raise ExecutableNotFound(
  303.                     "can't find the executable for the dialog-like "
  304.                     "program")
  305.     except os.error, v:
  306.         raise PythonDialogOSError(v.strerror)
  307.  
  308.     return res
  309.  
  310.  
  311. def _to_onoff(val):
  312.     """Convert boolean expressions to "on" or "off"
  313.  
  314.     This function converts every non-zero integer as well as "on",
  315.     "ON", "On" and "oN" to "on" and converts 0, "off", "OFF", etc. to
  316.     "off".
  317.  
  318.     Notable exceptions:
  319.  
  320.         PythonDialogReModuleError
  321.         BadPythonDialogUsage
  322.  
  323.     """
  324.     if type(val) == types.IntType:
  325.         if val:
  326.             return "on"
  327.         else:
  328.             return "off"
  329.     elif type(val) == types.StringType:
  330.         try:
  331.             if _on_rec.match(val):
  332.                 return "on"
  333.             elif _off_rec.match(val):
  334.                 return "off"
  335.         except re.error, v:
  336.             raise PythonDialogReModuleError(v)
  337.     else:
  338.         raise BadPythonDialogUsage("invalid boolean value: %s" % val)
  339.  
  340.  
  341. def _compute_common_args(dict):
  342.     """Compute the list of arguments for dialog common options.
  343.  
  344.     Compute a list of the command-line arguments to pass to dialog
  345.     from a keyword arguments dictionary for options listed as "common
  346.     options" in the manual page for dialog. These are the options
  347.     that are not tied to a particular widget.
  348.  
  349.     This allows to specify these options in a pythonic way, such as:
  350.  
  351.        d.checklist(<usual arguments for a checklist>,
  352.                    title="...",
  353.                    backtitle="...")
  354.  
  355.     instead of having to pass them with strings like "--title foo" or
  356.     "--backtitle bar".
  357.  
  358.     Notable exceptions: None
  359.  
  360.     """
  361.     args = []
  362.     for key in dict.keys():
  363.         args.extend(_common_args_syntax[key](dict[key]))
  364.     return args
  365.  
  366.  
  367. def _create_temporary_directory():
  368.     """Create a temporary directory (securely).
  369.  
  370.     Return the directory path.
  371.  
  372.     Notable exceptions:
  373.         - UnableToCreateTemporaryDirectory
  374.         - PythonDialogOSError
  375.         - exceptions raised by the tempfile module (which are
  376.           unfortunately not mentioned in its documentation, at
  377.           least in Python 2.3.3...)
  378.  
  379.     """
  380.     find_temporary_nb_attempts = 5
  381.     for tmpf in range(find_temporary_nb_attempts):
  382.         try:
  383.             # Using something >= 2**31 causes an error in Python 2.2...
  384.             tmp_dir = os.path.join(tempfile.gettempdir(), "%s-%u" % ("pythondialog", random.randint(0, 2**30-1)))
  385.         except os.error, v:
  386.             raise PythonDialogOSError(v.strerror)
  387.  
  388.         try:
  389.             os.mkdir(tmp_dir, 0700)
  390.         except os.error:
  391.             continue
  392.         else:
  393.             break
  394.     else:
  395.         raise UnableToCreateTemporaryDirectory(
  396.             "somebody may be trying to attack us")
  397.  
  398.     return tmp_dir
  399.  
  400.  
  401. # DIALOG_OK, DIALOG_CANCEL, etc. are environment variables controlling
  402. # dialog's exit status in the corresponding situation.
  403. #
  404. # Note:
  405. #    - 127 must not be used for any of the DIALOG_* values. It is used
  406. #      when a failure occurs in the child process before it exec()s
  407. #      dialog (where "before" includes a potential exec() failure).
  408. #    - 126 is also used (although in presumably rare situations).
  409. _dialog_exit_status_vars = { "OK": 0,
  410.                              "CANCEL": 1,
  411.                              "ESC": 2,
  412.                              "ERROR": 3,
  413.                              "EXTRA": 4,
  414.                              "HELP": 5 }
  415.  
  416.  
  417. # Main class of the module
  418. class Dialog:
  419.  
  420.     """Class providing bindings for dialog-compatible programs.
  421.  
  422.     This class allows you to invoke dialog or a compatible program in
  423.     a pythonic way to build quicky and easily simple but nice text
  424.     interfaces.
  425.  
  426.     An application typically creates one instance of the Dialog class
  427.     and uses it for all its widgets, but it is possible to use
  428.     concurrently several instances of this class with different
  429.     parameters (such as the background title) if you have the need
  430.     for this.
  431.  
  432.     The exit code (exit status) returned by dialog is to be
  433.     compared with the DIALOG_OK, DIALOG_CANCEL, DIALOG_ESC,
  434.     DIALOG_ERROR, DIALOG_EXTRA and DIALOG_HELP attributes of the
  435.     Dialog instance (they are integers).
  436.  
  437.     Note: although this class does all it can to allow the caller to
  438.           differentiate between the various reasons that caused a
  439.           dialog box to be closed, its backend, dialog 0.9a-20020309a
  440.           for my tests, doesn't always return DIALOG_ESC when the
  441.           user presses the ESC key, but often returns DIALOG_ERROR
  442.           instead. The exit codes returned by the corresponding
  443.           Dialog methods are of course just as wrong in these cases.
  444.           You've been warned.
  445.  
  446.  
  447.     Public methods of the Dialog class (mainly widgets)
  448.     ---------------------------------------------------
  449.  
  450.     The Dialog class has the following methods:
  451.  
  452.     add_persistent_args
  453.     calendar
  454.     checklist
  455.     form
  456.     fselect
  457.  
  458.     gauge_start
  459.     gauge_update
  460.     gauge_stop
  461.  
  462.     infobox
  463.     inputbox
  464.     menu
  465.     msgbox
  466.     passwordbox
  467.     radiolist
  468.     scrollbox
  469.     tailbox
  470.     textbox
  471.     timebox
  472.     yesno
  473.  
  474.     clear                 (obsolete)
  475.     setBackgroundTitle    (obsolete)
  476.  
  477.  
  478.     Passing dialog "Common Options"
  479.     -------------------------------
  480.  
  481.     Every widget method has a **kwargs argument allowing you to pass
  482.     dialog so-called Common Options (see the dialog(1) manual page)
  483.     to dialog for this widget call. For instance, if `d' is a Dialog
  484.     instance, you can write:
  485.  
  486.       d.checklist(args, ..., title="A Great Title", no_shadow=1)
  487.  
  488.     The no_shadow option is worth looking at:
  489.  
  490.       1. It is an option that takes no argument as far as dialog is
  491.          concerned (unlike the "--title" option, for instance). When
  492.          you list it as a keyword argument, the option is really
  493.          passed to dialog only if the value you gave it evaluates to
  494.          true, e.g. "no_shadow=1" will cause "--no-shadow" to be
  495.          passed to dialog whereas "no_shadow=0" will cause this
  496.          option not to be passed to dialog at all.
  497.  
  498.       2. It is an option that has a hyphen (-) in its name, which you
  499.          must change into an underscore (_) to pass it as a Python
  500.          keyword argument. Therefore, "--no-shadow" is passed by
  501.          giving a "no_shadow=1" keyword argument to a Dialog method
  502.          (the leading two dashes are also consistently removed).
  503.  
  504.  
  505.     Exceptions
  506.     ----------
  507.  
  508.     Please refer to the specific methods' docstrings or simply to the
  509.     module's docstring for a list of all exceptions that might be
  510.     raised by this class' methods.
  511.  
  512.     """
  513.  
  514.     def __init__(self, dialog="dialog", DIALOGRC=None, compat="dialog", use_stdout=None):
  515.         """Constructor for Dialog instances.
  516.  
  517.         dialog   -- name of (or path to) the dialog-like program to
  518.                     use; if it contains a '/', it is assumed to be a
  519.                     path and is used as is; otherwise, it is looked
  520.                     for according to the contents of the PATH
  521.                     environment variable, which defaults to
  522.                     ":/bin:/usr/bin" if unset.
  523.         DIALOGRC -- string to pass to the dialog-like program as the
  524.                     DIALOGRC environment variable, or None if no
  525.                     modification to the environment regarding this
  526.                     variable should be done in the call to the
  527.                     dialog-like program
  528.         compat   -- compatibility mode (see below)
  529.  
  530.         The officially supported dialog-like program in pythondialog
  531.         is the well-known dialog program written in C, based on the
  532.         ncurses library. It is also known as cdialog and its home
  533.         page is currently (2004-03-15) located at:
  534.  
  535.             http://dickey.his.com/dialog/dialog.html
  536.  
  537.         If you want to use a different program such as Xdialog, you
  538.         should indicate the executable file name with the `dialog'
  539.         argument *and* the compatibility type that you think it
  540.         conforms to with the `compat' argument. Currently, `compat'
  541.         can be either "dialog" (for dialog; this is the default) or
  542.         "Xdialog" (for, well, Xdialog).
  543.  
  544.         The `compat' argument allows me to cope with minor
  545.         differences in behaviour between the various programs
  546.         implementing the dialog interface (not the text or graphical
  547.         interface, I mean the "API"). However, having to support
  548.         various APIs simultaneously is a bit ugly and I would really
  549.         prefer you to report bugs to the relevant maintainers when
  550.         you find incompatibilities with dialog. This is for the
  551.         benefit of pretty much everyone that relies on the dialog
  552.         interface.
  553.  
  554.         Notable exceptions:
  555.  
  556.             ExecutableNotFound
  557.             PythonDialogOSError
  558.  
  559.         """        
  560.         # DIALOGRC differs from the other DIALOG* variables in that:
  561.         #   1. It should be a string if not None
  562.         #   2. We may very well want it to be unset
  563.         if DIALOGRC is not None:
  564.             self.DIALOGRC = DIALOGRC
  565.  
  566.         # After reflexion, I think DIALOG_OK, DIALOG_CANCEL, etc.
  567.         # should never have been instance attributes (I cannot see a
  568.         # reason why the user would want to change their values or
  569.         # even read them), but it is a bit late, now. So, we set them
  570.         # based on the (global) _dialog_exit_status_vars.keys.
  571.         for var in _dialog_exit_status_vars.keys():
  572.             varname = "DIALOG_" + var
  573.             setattr(self, varname, _dialog_exit_status_vars[var])
  574.  
  575.         self._dialog_prg = _path_to_executable(dialog)
  576.         self.compat = compat
  577.         self.dialog_persistent_arglist = []
  578.  
  579.         # Use stderr or stdout?
  580.         if self.compat == "Xdialog":
  581.             # Default to stdout if Xdialog
  582.             self.use_stdout = True
  583.         else:
  584.             self.use_stdout = False
  585.         if use_stdout != None:
  586.             # Allow explicit setting
  587.             self.use_stdout = use_stdout
  588.         if self.use_stdout:
  589.             self.add_persistent_args(["--stdout"])
  590.  
  591.     def add_persistent_args(self, arglist):
  592.         self.dialog_persistent_arglist.extend(arglist)
  593.  
  594.     # For compatibility with the old dialog...
  595.     def setBackgroundTitle(self, text):
  596.         """Set the background title for dialog.
  597.  
  598.         This method is obsolete. Please remove calls to it from your
  599.         programs.
  600.  
  601.         """
  602.         self.add_persistent_args(("--backtitle", text))
  603.  
  604.     def _call_program(self, redirect_child_stdin, cmdargs, **kwargs):
  605.         """Do the actual work of invoking the dialog-like program.
  606.  
  607.         Communication with the dialog-like program is performed
  608.         through one or two pipes, depending on
  609.         `redirect_child_stdin'. There is always one pipe that is
  610.         created to allow the parent process to read what dialog
  611.         writes on its standard error stream.
  612.         
  613.         If `redirect_child_stdin' is True, an additional pipe is
  614.         created whose reading end is connected to dialog's standard
  615.         input. This is used by the gauge widget to feed data to
  616.         dialog.
  617.  
  618.         Beware when interpreting the return value: the length of the
  619.         returned tuple depends on `redirect_child_stdin'.
  620.  
  621.         Notable exception: PythonDialogOSError (if pipe() or close()
  622.                            system calls fail...)
  623.  
  624.         """
  625.         # We want to define DIALOG_OK, DIALOG_CANCEL, etc. in the
  626.         # environment of the child process so that we know (and
  627.         # even control) the possible dialog exit statuses.
  628.         new_environ = {}
  629.         new_environ.update(os.environ)
  630.         for var in _dialog_exit_status_vars:
  631.             varname = "DIALOG_" + var
  632.             new_environ[varname] = str(getattr(self, varname))
  633.         if hasattr(self, "DIALOGRC"):
  634.             new_environ["DIALOGRC"] = self.DIALOGRC
  635.  
  636.         # Create:
  637.         #   - a pipe so that the parent process can read dialog's output on
  638.         #     stdout/stderr
  639.         #   - a pipe so that the parent process can feed data to dialog's
  640.         #     stdin (this is needed for the gauge widget) if
  641.         #     redirect_child_stdin is True
  642.         try:
  643.             # rfd = File Descriptor for Reading
  644.             # wfd = File Descriptor for Writing
  645.             (child_rfd, child_wfd) = os.pipe()
  646.             if redirect_child_stdin:
  647.                 (child_stdin_rfd,  child_stdin_wfd)  = os.pipe()
  648.         except os.error, v:
  649.             raise PythonDialogOSError(v.strerror)
  650.  
  651.         child_pid = os.fork()
  652.         if child_pid == 0:
  653.             # We are in the child process. We MUST NOT raise any exception.
  654.             try:
  655.                 # The child process doesn't need these file descriptors
  656.                 os.close(child_rfd)
  657.                 if redirect_child_stdin:
  658.                     os.close(child_stdin_wfd)
  659.                 # We want:
  660.                 #   - dialog's output on stderr/stdout to go to child_wfd
  661.                 #   - data written to child_stdin_wfd to go to dialog's stdin
  662.                 #     if redirect_child_stdin is True
  663.                 if self.use_stdout:
  664.                     os.dup2(child_wfd, 1)
  665.                 else:
  666.                     os.dup2(child_wfd, 2)
  667.                 if redirect_child_stdin:
  668.                     os.dup2(child_stdin_rfd, 0)
  669.  
  670.                 arglist = [self._dialog_prg] + self.dialog_persistent_arglist + _compute_common_args(kwargs) + cmdargs
  671.                 # Insert here the contents of the DEBUGGING file if you want
  672.                 # to obtain a handy string of the complete command line with
  673.                 # arguments quoted for the shell and environment variables
  674.                 # set.
  675.                 os.execve(self._dialog_prg, arglist, new_environ)
  676.             except:
  677.                 os._exit(127)
  678.  
  679.             # Should not happen unless there is a bug in Python
  680.             os._exit(126)
  681.  
  682.         # We are in the father process.
  683.         #
  684.         # It is essential to close child_wfd, otherwise we will never
  685.         # see EOF while reading on child_rfd and the parent process
  686.         # will block forever on the read() call.
  687.         # [ after the fork(), the "reference count" of child_wfd from
  688.         #   the operating system's point of view is 2; after the child exits,
  689.         #   it is 1 until the father closes it itself; then it is 0 and a read
  690.         #   on child_rfd encounters EOF once all the remaining data in
  691.         #   the pipe has been read. ]
  692.         try:
  693.             os.close(child_wfd)
  694.             if redirect_child_stdin:
  695.                 os.close(child_stdin_rfd)
  696.                 return (child_pid, child_rfd, child_stdin_wfd)
  697.             else:
  698.                 return (child_pid, child_rfd)
  699.         except os.error, v:
  700.             raise PythonDialogOSError(v.strerror)
  701.  
  702.     def _wait_for_program_termination(self, child_pid, child_rfd):
  703.         """Wait for a dialog-like process to terminate.
  704.  
  705.         This function waits for the specified process to terminate,
  706.         raises the appropriate exceptions in case of abnormal
  707.         termination and returns the exit status and standard error
  708.         output of the process as a tuple: (exit_code, stderr_string).
  709.  
  710.         `child_rfd' must be the file descriptor for the
  711.         reading end of the pipe created by self._call_program()
  712.         whose writing end was connected by self._call_program() to
  713.         the child process's standard error.
  714.  
  715.         This function reads the process's output on standard error
  716.         from `child_rfd' and closes this file descriptor once
  717.         this is done.
  718.  
  719.         Notable exceptions:
  720.  
  721.             DialogTerminatedBySignal
  722.             DialogError
  723.             PythonDialogErrorBeforeExecInChildProcess
  724.             PythonDialogIOError
  725.             PythonDialogBug
  726.             ProbablyPythonBug
  727.  
  728.         """
  729.         exit_info = os.waitpid(child_pid, 0)[1]
  730.         if os.WIFEXITED(exit_info):
  731.             exit_code = os.WEXITSTATUS(exit_info)
  732.         # As we wait()ed for the child process to terminate, there is no
  733.         # need to call os.WIFSTOPPED()
  734.         elif os.WIFSIGNALED(exit_info):
  735.             raise DialogTerminatedBySignal("the dialog-like program was terminated by signal %u" % os.WTERMSIG(exit_info))
  736.         else:
  737.             raise PythonDialogBug("please report this bug to the pythondialog maintainers")
  738.  
  739.         if exit_code == self.DIALOG_ERROR:
  740.             raise DialogError("the dialog-like program exited with code %d (was passed to it as the DIALOG_ERROR environment variable)" % exit_code)
  741.         elif exit_code == 127:
  742.             raise PythonDialogErrorBeforeExecInChildProcess(
  743.                 "perhaps the dialog-like program could not be executed; perhaps the system is out of memory; perhaps the maximum number of open file descriptors has been reached")
  744.         elif exit_code == 126:
  745.             raise ProbablyPythonBug(
  746.                 "a child process returned with exit status 126; this might be the exit status of the dialog-like program, for some unknown reason (-> probably a bug in the dialog-like program); otherwise, we have probably found a python bug")
  747.         
  748.         # We might want to check here whether exit_code is really one of
  749.         # DIALOG_OK, DIALOG_CANCEL, etc. However, I prefer not doing it
  750.         # because it would break pythondialog for no strong reason when new
  751.         # exit codes are added to the dialog-like program.
  752.         #
  753.         # As it is now, if such a thing happens, the program using
  754.         # pythondialog may receive an exit_code it doesn't know about. OK, the
  755.         # programmer just has to tell the pythondialog maintainer about it and
  756.         # can temporarily set the appropriate DIALOG_* environment variable if
  757.         # he wants and assign the corresponding value to the Dialog instance's
  758.         # DIALOG_FOO attribute from his program. He doesn't even need to use a
  759.         # patched pythondialog before he upgrades to a version that knows
  760.         # about the new exit codes.
  761.         #
  762.         # The bad thing that might happen is a new DIALOG_FOO exit code being
  763.         # the same by default as one of those we chose for the other exit
  764.         # codes already known by pythondialog. But in this situation, the
  765.         # check that is being discussed wouldn't help at all.
  766.  
  767.         # Read dialog's output on its stderr
  768.         try:
  769.             child_output = os.fdopen(child_rfd, "rb").read()
  770.             # Now, since the file object has no reference anymore, the
  771.             # standard IO stream behind it will be closed, causing the
  772.             # end of the the pipe we used to read dialog's output on its
  773.             # stderr to be closed (this is important, otherwise invoking
  774.             # dialog enough times will eventually exhaust the maximum number
  775.             # of open file descriptors).
  776.         except IOError, v:
  777.             raise PythonDialogIOError(v)
  778.  
  779.         return (exit_code, child_output)
  780.  
  781.     def _perform(self, cmdargs, **kwargs):
  782.         """Perform a complete dialog-like program invocation.
  783.  
  784.         This function invokes the dialog-like program, waits for its
  785.         termination and returns its exit status and whatever it wrote
  786.         on its standard error stream.
  787.  
  788.         Notable exceptions:
  789.  
  790.             any exception raised by self._call_program() or
  791.             self._wait_for_program_termination()
  792.  
  793.         """
  794.         (child_pid, child_rfd) = self._call_program(False, *(cmdargs,), **kwargs)
  795.         (exit_code, output) = self._wait_for_program_termination(child_pid,    child_rfd)
  796.         return (exit_code, output)
  797.  
  798.     def _strip_xdialog_newline(self, output):
  799.         """Remove trailing newline (if any), if using Xdialog"""
  800.         if self.compat == "Xdialog" and output.endswith("\n"):
  801.             output = output[:-1]
  802.         return output
  803.  
  804.     # This is for compatibility with the old dialog.py
  805.     def _perform_no_options(self, cmd):
  806.         """Call dialog without passing any more options."""
  807.         return os.system(self._dialog_prg + ' ' + cmd)
  808.  
  809.     # For compatibility with the old dialog.py
  810.     def clear(self):
  811.         """Clear the screen. Equivalent to the dialog --clear option.
  812.  
  813.         This method is obsolete. Please remove calls to it from your
  814.         programs.
  815.  
  816.         """
  817.         self._perform_no_options('--clear')
  818.  
  819.     def calendar(self, text, height=6, width=0, day=0, month=0, year=0, **kwargs):
  820.         """Display a calendar dialog box.
  821.  
  822.         text   -- text to display in the box
  823.         height -- height of the box (minus the calendar height)
  824.         width  -- width of the box
  825.         day    -- inititial day highlighted
  826.         month  -- inititial month displayed
  827.         year   -- inititial year selected (0 causes the current date
  828.                   to be used as the initial date)
  829.         
  830.         A calendar box displays month, day and year in separately
  831.         adjustable windows. If the values for day, month or year are
  832.         missing or negative, the current date's corresponding values
  833.         are used. You can increment or decrement any of those using
  834.         the left, up, right and down arrows. Use tab or backtab to
  835.         move between windows. If the year is given as zero, the
  836.         current date is used as an initial value.
  837.  
  838.         Return a tuple of the form (code, date) where `code' is the
  839.         exit status (an integer) of the dialog-like program and
  840.         `date' is a list of the form [day, month, year] (where `day',
  841.         `month' and `year' are integers corresponding to the date
  842.         chosen by the user) if the box was closed with OK, or None if
  843.         it was closed with the Cancel button.
  844.  
  845.         Notable exceptions:
  846.             - any exception raised by self._perform()
  847.             - UnexpectedDialogOutput
  848.             - PythonDialogReModuleError
  849.  
  850.         """
  851.         (code, output) = self._perform( *(["--calendar", text, str(height), str(width), str(day), str(month), str(year)],), **kwargs)
  852.         if code == self.DIALOG_OK:
  853.             try:
  854.                 mo = _calendar_date_rec.match(output)
  855.             except re.error, v:
  856.                 raise PythonDialogReModuleError(v)
  857.             
  858.             if mo is None:
  859.                 raise UnexpectedDialogOutput(
  860.                     "the dialog-like program returned the following "
  861.                     "unexpected date with the calendar box: %s" % output)
  862.             date = map(int, mo.group("day", "month", "year"))
  863.         else:
  864.             date = None
  865.         return (code, date)
  866.  
  867.     def checklist(self, text, height=15, width=54, list_height=7, choices=[], **kwargs):
  868.         """Display a checklist box.
  869.  
  870.         text        -- text to display in the box
  871.         height      -- height of the box
  872.         width       -- width of the box
  873.         list_height -- number of entries displayed in the box (which
  874.                        can be scrolled) at a given time
  875.         choices     -- a list of tuples (tag, item, status) where
  876.                        `status' specifies the initial on/off state of
  877.                        each entry; can be 0 or 1 (integers, 1 meaning
  878.                        checked, i.e. "on"), or "on", "off" or any
  879.                        uppercase variant of these two strings.
  880.  
  881.         Return a tuple of the form (code, [tag, ...]) with the tags
  882.         for the entries that were selected by the user. `code' is the
  883.         exit status of the dialog-like program.
  884.  
  885.         If the user exits with ESC or CANCEL, the returned tag list
  886.         is empty.
  887.  
  888.         Notable exceptions:
  889.  
  890.             any exception raised by self._perform() or _to_onoff()
  891.  
  892.         """
  893.         cmd = ["--checklist", text, str(height), str(width), str(list_height)]
  894.         for t in choices:
  895.             cmd.extend(((t[0], t[1], _to_onoff(t[2]))))
  896.  
  897.         # The dialog output cannot be parsed reliably (at least in dialog
  898.         # 0.9b-20040301) without --separate-output (because double quotes in
  899.         # tags are escaped with backslashes, but backslashes are not
  900.         # themselves escaped and you have a problem when a tag ends with a
  901.         # backslash--the output makes you think you've encountered an embedded
  902.         # double-quote).
  903.         kwargs["separate_output"] = True
  904.  
  905.         (code, output) = self._perform(*(cmd,), **kwargs)
  906.  
  907.         # Since we used --separate-output, the tags are separated by a newline
  908.         # in the output. There is also a final newline after the last tag.
  909.         if output:
  910.             return (code, string.split(output, '\n')[:-1])
  911.         else:                           # empty selection
  912.             return (code, [])
  913.     
  914.     def form(self, formtitle, fields, height=25, formheight=10, **kwargs):
  915.         """Display a set of form fields.
  916.     
  917.         formtitle -- Title of the form
  918.         fields -- ('Field Label', 'Max length,', 'Default Value')
  919.             Field Label -- The label displayed before the input box
  920.             Max Length -- The maximum size the input box should be
  921.             Default Value -- A default value for the field (Optional)
  922.         
  923.         The form dialog allows one to build multiple inputs into one dialog box.
  924.         Just like a web based form you use TAB to move between fields and ENTER
  925.         to submit the dialog.
  926.     
  927.         It returns a tuple containing the form data.
  928.         
  929.         Typical usage:
  930.             data = d.form('title',(('Interface',5,'eth0'),('IP Address', 15), ('Netmask', 15)))
  931.         """
  932.     
  933.         #Find the maximum size of the labels and boxes
  934.         maxoptlen = 0
  935.         maxinputlen = 0
  936.         for field in fields:
  937.             if len(field[0]) > maxoptlen:
  938.                 maxoptlen = len(field[0])
  939.     
  940.             if int(field[1]) > maxinputlen:
  941.                 maxinputlen = int(field[1])
  942.     
  943.         #Set the starting args FIXME: Do a real calc of the second arg
  944.         formargs = ["--form", formtitle, str(height) , maxinputlen + maxoptlen + 12, str(formheight)]
  945.     
  946.         #Make the args for the fields
  947.         counter = 1
  948.         for field in fields:
  949.             formargs.append(field[0])
  950.             formargs.append(counter)
  951.             formargs.append(1)
  952.     
  953.             if len(field) > 2:
  954.                 formargs.append(field[2])
  955.             else:
  956.                 formargs.append('')
  957.             
  958.             formargs.append(counter)
  959.             formargs.append(maxoptlen+5)
  960.             formargs.append(int(field[1])+1)
  961.             formargs.append(field[1])
  962.     
  963.             counter = counter + 1
  964.         
  965.         #Run the dialog program 
  966.         for x in range(0, len(formargs)):
  967.             formargs[x] = str(formargs[x])
  968.         (code, output) = self._perform( *([formargs]),**kwargs)
  969.     
  970.         output = self._strip_xdialog_newline(output)
  971.         
  972.         return (code, output)
  973.     
  974.     def fselect(self, filepath, height, width, **kwargs):
  975.         """Display a file selection dialog box.
  976.  
  977.         filepath -- initial file path
  978.         height   -- height of the box
  979.         width    -- width of the box
  980.         
  981.         The file-selection dialog displays a text-entry window in
  982.         which you can type a filename (or directory), and above that
  983.         two windows with directory names and filenames.
  984.  
  985.         Here, filepath can be a file path in which case the file and
  986.         directory windows will display the contents of the path and
  987.         the text-entry window will contain the preselected filename.
  988.  
  989.         Use tab or arrow keys to move between the windows. Within the
  990.         directory or filename windows, use the up/down arrow keys to
  991.         scroll the current selection. Use the space-bar to copy the
  992.         current selection into the text-entry window.
  993.  
  994.         Typing any printable character switches focus to the
  995.         text-entry window, entering that character as well as
  996.         scrolling the directory and filename windows to the closest
  997.         match.
  998.  
  999.         Use a carriage return or the "OK" button to accept the
  1000.         current value in the text-entry window, or the "Cancel"
  1001.         button to cancel.
  1002.  
  1003.         Return a tuple of the form (code, path) where `code' is the
  1004.         exit status (an integer) of the dialog-like program and
  1005.         `path' is the path chosen by the user (whose last element may
  1006.         be a directory or a file).
  1007.               
  1008.         Notable exceptions:
  1009.  
  1010.             any exception raised by self._perform()
  1011.  
  1012.     """
  1013.         (code, output) = self._perform(*(["--fselect", filepath, str(height), str(width)],),**kwargs)
  1014.  
  1015.         output = self._strip_xdialog_newline(output)
  1016.         
  1017.         return (code, output)
  1018.     
  1019.     def gauge_start(self, text="", height=8, width=54, percent=0, **kwargs):
  1020.         """Display gauge box.
  1021.  
  1022.         text    -- text to display in the box
  1023.         height  -- height of the box
  1024.         width   -- width of the box
  1025.         percent -- initial percentage shown in the meter
  1026.  
  1027.         A gauge box displays a meter along the bottom of the box. The
  1028.         meter indicates a percentage.
  1029.  
  1030.         This function starts the dialog-like program telling it to
  1031.         display a gauge box with a text in it and an initial
  1032.         percentage in the meter.
  1033.  
  1034.         Return value: undefined.
  1035.  
  1036.  
  1037.         Gauge typical usage
  1038.         -------------------
  1039.  
  1040.         Gauge typical usage (assuming that `d' is an instance of the Dialog class) looks like this:
  1041.         d.gauge_start()
  1042.         # do something
  1043.         d.gauge_update(10)       # 10% of the whole task is done
  1044.         # ...
  1045.         d.gauge_update(100, "any text here") # work is done
  1046.         exit_code = d.gauge_stop()           # cleanup actions
  1047.  
  1048.  
  1049.         Notable exceptions:
  1050.             - any exception raised by self._call_program()
  1051.             - PythonDialogOSError
  1052.  
  1053.         """
  1054.         (child_pid, child_rfd, child_stdin_wfd) = self._call_program(True,*(["--gauge", text, str(height), str(width), str(percent)],), **kwargs)
  1055.         try:
  1056.             self._gauge_process = {
  1057.                 "pid": child_pid,
  1058.                 "stdin": os.fdopen(child_stdin_wfd, "wb"),
  1059.                 "child_rfd": child_rfd
  1060.                 }
  1061.         except os.error, v:
  1062.             raise PythonDialogOSError(v.strerror)
  1063.             
  1064.     def gauge_update(self, percent, text="", update_text=0):
  1065.         """Update a running gauge box.
  1066.     
  1067.         percent     -- new percentage to show in the gauge meter
  1068.         text        -- new text to optionally display in the box
  1069.         update-text -- boolean indicating whether to update the
  1070.                        text in the box
  1071.  
  1072.         This function updates the percentage shown by the meter of a
  1073.         running gauge box (meaning `gauge_start' must have been
  1074.         called previously). If update_text is true (for instance, 1),
  1075.         the text displayed in the box is also updated.
  1076.  
  1077.         See the `gauge_start' function's documentation for
  1078.         information about how to use a gauge.
  1079.  
  1080.         Return value: undefined.
  1081.  
  1082.         Notable exception: PythonDialogIOError can be raised if there
  1083.                            is an I/O error while writing to the pipe
  1084.                            used to talk to the dialog-like program.
  1085.  
  1086.         """
  1087.         if update_text:
  1088.             gauge_data = "%d\nXXX\n%s\nXXX\n" % (percent, text)
  1089.         else:
  1090.             gauge_data = "%d\n" % percent
  1091.         try:
  1092.             self._gauge_process["stdin"].write(gauge_data)
  1093.             self._gauge_process["stdin"].flush()
  1094.         except IOError, v:
  1095.             raise PythonDialogIOError(v)
  1096.     
  1097.         # For "compatibility" with the old dialog.py...
  1098.         # gauge_iterate = gauge_update
  1099.  
  1100.     def gauge_stop(self):
  1101.         """Terminate a running gauge.
  1102.  
  1103.         This function performs the appropriate cleanup actions to
  1104.         terminate a running gauge (started with `gauge_start').
  1105.     
  1106.         See the `gauge_start' function's documentation for
  1107.         information about how to use a gauge.
  1108.  
  1109.         Return value: undefined.
  1110.  
  1111.         Notable exceptions:
  1112.             - any exception raised by
  1113.               self._wait_for_program_termination()
  1114.             - PythonDialogIOError can be raised if closing the pipe
  1115.               used to talk to the dialog-like program fails.
  1116.  
  1117.         """
  1118.         p = self._gauge_process
  1119.         # Close the pipe that we are using to feed dialog's stdin
  1120.         try:
  1121.             p["stdin"].close()
  1122.         except IOError, v:
  1123.             raise PythonDialogIOError(v)
  1124.         exit_code = self._wait_for_program_termination(p["pid"], p["child_rfd"])[0]
  1125.         return exit_code
  1126.  
  1127.     def infobox(self, text, height=10, width=30, **kwargs):
  1128.         """Display an information dialog box.
  1129.  
  1130.         text   -- text to display in the box
  1131.         height -- height of the box
  1132.         width  -- width of the box
  1133.  
  1134.         An info box is basically a message box. However, in this
  1135.         case, dialog will exit immediately after displaying the
  1136.         message to the user. The screen is not cleared when dialog
  1137.         exits, so that the message will remain on the screen until
  1138.         the calling shell script clears it later. This is useful
  1139.         when you want to inform the user that some operations are
  1140.         carrying on that may require some time to finish.
  1141.  
  1142.         Return the exit status (an integer) of the dialog-like
  1143.         program.
  1144.  
  1145.         Notable exceptions:
  1146.  
  1147.             any exception raised by self._perform()
  1148.  
  1149.     """
  1150.         return self._perform(*(["--infobox", text, str(height), str(width)],),**kwargs)[0]
  1151.  
  1152.     def inputbox(self, text, height=10, width=30, init='', **kwargs):
  1153.         """Display an input dialog box.
  1154.  
  1155.         text   -- text to display in the box
  1156.         height -- height of the box
  1157.         width  -- width of the box
  1158.         init   -- default input string
  1159.  
  1160.         An input box is useful when you want to ask questions that
  1161.         require the user to input a string as the answer. If init is
  1162.         supplied it is used to initialize the input string. When
  1163.         entering the string, the BACKSPACE key can be used to
  1164.         correct typing errors. If the input string is longer than
  1165.         can fit in the dialog box, the input field will be scrolled.
  1166.  
  1167.         Return a tuple of the form (code, string) where `code' is the
  1168.         exit status of the dialog-like program and `string' is the
  1169.         string entered by the user.
  1170.  
  1171.         Notable exceptions:
  1172.  
  1173.             any exception raised by self._perform()
  1174.  
  1175.         """
  1176.         (code, tag) = self._perform(*(["--inputbox", text, str(height), str(width), init],),**kwargs)
  1177.  
  1178.         tag = self._strip_xdialog_newline(tag)
  1179.         
  1180.         return (code, tag)
  1181.  
  1182.     def menu(self, text, height=15, width=54, menu_height=7, choices=[],
  1183.              **kwargs):
  1184.         """Display a menu dialog box.
  1185.  
  1186.         text        -- text to display in the box
  1187.         height      -- height of the box
  1188.         width       -- width of the box
  1189.         menu_height -- number of entries displayed in the box (which
  1190.                        can be scrolled) at a given time
  1191.         choices     -- a sequence of (tag, item) or (tag, item, help)
  1192.                        tuples (the meaning of each `tag', `item' and
  1193.                        `help' is explained below)
  1194.  
  1195.  
  1196.         Overview
  1197.         --------
  1198.  
  1199.         As its name suggests, a menu box is a dialog box that can be
  1200.         used to present a list of choices in the form of a menu for
  1201.         the user to choose. Choices are displayed in the order given.
  1202.  
  1203.         Each menu entry consists of a `tag' string and an `item'
  1204.         string. The tag gives the entry a name to distinguish it from
  1205.         the other entries in the menu. The item is a short
  1206.         description of the option that the entry represents.
  1207.  
  1208.         The user can move between the menu entries by pressing the
  1209.         UP/DOWN keys, the first letter of the tag as a hot-key, or
  1210.         the number keys 1-9. There are menu-height entries displayed
  1211.         in the menu at one time, but the menu will be scrolled if
  1212.         there are more entries than that.
  1213.  
  1214.  
  1215.         Providing on-line help facilities
  1216.         ---------------------------------
  1217.  
  1218.         If this function is called with item_help=1 (keyword
  1219.         argument), the option --item-help is passed to dialog and the
  1220.         tuples contained in `choices' must contain 3 elements each :
  1221.         (tag, item, help). The help string for the highlighted item
  1222.         is displayed in the bottom line of the screen and updated as
  1223.         the user highlights other items.
  1224.  
  1225.         If item_help=0 or if this keyword argument is not passed to
  1226.         this function, the tuples contained in `choices' must contain
  1227.         2 elements each : (tag, item).
  1228.  
  1229.         If this function is called with help_button=1, it must also
  1230.         be called with item_help=1 (this is a limitation of dialog),
  1231.         therefore the tuples contained in `choices' must contain 3
  1232.         elements each as explained in the previous paragraphs. This
  1233.         will cause a Help button to be added to the right of the
  1234.         Cancel button (by passing --help-button to dialog).
  1235.  
  1236.  
  1237.         Return value
  1238.         ------------
  1239.  
  1240.         Return a tuple of the form (exit_info, string).
  1241.  
  1242.         `exit_info' is either:
  1243.           - an integer, being the the exit status of the dialog-like
  1244.             program
  1245.           - or the string "help", meaning that help_button=1 was
  1246.             passed and that the user chose the Help button instead of
  1247.             OK or Cancel.
  1248.  
  1249.         The meaning of `string' depends on the value of exit_info:
  1250.           - if `exit_info' is 0, `string' is the tag chosen by the
  1251.             user
  1252.           - if `exit_info' is "help", `string' is the `help' string
  1253.             from the `choices' argument corresponding to the item
  1254.             that was highlighted when the user chose the Help button
  1255.           - otherwise (the user chose Cancel or pressed Esc, or there
  1256.             was a dialog error), the value of `string' is undefined.
  1257.  
  1258.         Notable exceptions:
  1259.  
  1260.             any exception raised by self._perform()
  1261.  
  1262.         """
  1263.         cmd = ["--menu", text, str(height), str(width), str(menu_height)]
  1264.         for t in choices:
  1265.             cmd.extend(t)
  1266.         (code, output) = self._perform(*(cmd,), **kwargs)
  1267.  
  1268.         output = self._strip_xdialog_newline(output)
  1269.         
  1270.         if "help_button" in kwargs.keys() and output.startswith("HELP "):
  1271.             return ("help", output[5:])
  1272.         else:
  1273.             return (code, output)
  1274.  
  1275.     def msgbox(self, text, height=10, width=30, **kwargs):
  1276.         """Display a message dialog box.
  1277.  
  1278.         text   -- text to display in the box
  1279.         height -- height of the box
  1280.         width  -- width of the box
  1281.  
  1282.         A message box is very similar to a yes/no box. The only
  1283.         difference between a message box and a yes/no box is that a
  1284.         message box has only a single OK button. You can use this
  1285.         dialog box to display any message you like. After reading
  1286.         the message, the user can press the ENTER key so that dialog
  1287.         will exit and the calling program can continue its
  1288.         operation.
  1289.  
  1290.         Return the exit status (an integer) of the dialog-like
  1291.         program.
  1292.  
  1293.         Notable exceptions:
  1294.  
  1295.             any exception raised by self._perform()
  1296.  
  1297.     """
  1298.         return self._perform(*(["--msgbox", text, str(height), str(width)],), **kwargs)[0]
  1299.  
  1300.     def passwordbox(self, text, height=10, width=60, init='', **kwargs):
  1301.         """Display an password input dialog box.
  1302.  
  1303.         text   -- text to display in the box
  1304.         height -- height of the box
  1305.         width  -- width of the box
  1306.         init   -- default input password
  1307.  
  1308.         A password box is similar to an input box, except that the
  1309.         text the user enters is not displayed. This is useful when
  1310.         prompting for passwords or other sensitive information. Be
  1311.         aware that if anything is passed in "init", it will be
  1312.         visible in the system's process table to casual snoopers.
  1313.         Also, it is very confusing to the user to provide them with a
  1314.         default password they cannot see. For these reasons, using
  1315.         "init" is highly discouraged.
  1316.  
  1317.         Return a tuple of the form (code, password) where `code' is
  1318.         the exit status of the dialog-like program and `password' is
  1319.         the password entered by the user.
  1320.  
  1321.         Notable exceptions:
  1322.  
  1323.             any exception raised by self._perform()
  1324.  
  1325.         """
  1326.         (code, password) = self._perform(*(["--passwordbox", text, str(height), str(width), init],),**kwargs)
  1327.  
  1328.         password = self._strip_xdialog_newline(password)
  1329.  
  1330.         return (code, password)
  1331.  
  1332.     def radiolist(self, text, height=15, width=54, list_height=7, choices=[], **kwargs):
  1333.         """Display a radiolist box.
  1334.  
  1335.         text        -- text to display in the box
  1336.         height      -- height of the box
  1337.         width       -- width of the box
  1338.         list_height -- number of entries displayed in the box (which
  1339.                        can be scrolled) at a given time
  1340.         choices     -- a list of tuples (tag, item, status) where
  1341.                        `status' specifies the initial on/off state
  1342.                        each entry; can be 0 or 1 (integers, 1 meaning
  1343.                        checked, i.e. "on"), or "on", "off" or any
  1344.                        uppercase variant of these two strings.
  1345.                        No more than one entry should  be set to on.
  1346.  
  1347.         A radiolist box is similar to a menu box. The main difference
  1348.         is that you can indicate which entry is initially selected,
  1349.         by setting its status to on.
  1350.  
  1351.         Return a tuple of the form (code, tag) with the tag for the
  1352.         entry that was chosen by the user. `code' is the exit status
  1353.         of the dialog-like program.
  1354.  
  1355.         If the user exits with ESC or CANCEL, or if all entries were
  1356.         initially set to off and not altered before the user chose
  1357.         OK, the returned tag is the empty string.
  1358.  
  1359.         Notable exceptions:
  1360.  
  1361.             any exception raised by self._perform() or _to_onoff()
  1362.  
  1363.         """
  1364.         cmd = ["--radiolist", text, str(height), str(width), str(list_height)]
  1365.         for t in choices:
  1366.             cmd.extend(((t[0], t[1], _to_onoff(t[2]))))
  1367.  
  1368.         (code, tag) = self._perform(*(cmd,), **kwargs)
  1369.  
  1370.         tag = self._strip_xdialog_newline(tag)
  1371.             
  1372.         return (code, tag)
  1373.  
  1374.     def scrollbox(self, text, height=20, width=78, **kwargs):
  1375.         """Display a string in a scrollable box.
  1376.  
  1377.         text   -- text to display in the box
  1378.         height -- height of the box
  1379.         width  -- width of the box
  1380.  
  1381.         This method is a layer on top of textbox. The textbox option
  1382.         in dialog allows to display file contents only. This method
  1383.         allows you to display any text in a scrollable box. This is
  1384.         simply done by creating a temporary file, calling textbox and
  1385.         deleting the temporary file afterwards.
  1386.  
  1387.         Return the dialog-like program's exit status.
  1388.  
  1389.         Notable exceptions:
  1390.             - UnableToCreateTemporaryDirectory
  1391.             - PythonDialogIOError
  1392.             - PythonDialogOSError
  1393.             - exceptions raised by the tempfile module (which are
  1394.               unfortunately not mentioned in its documentation, at
  1395.               least in Python 2.3.3...)
  1396.  
  1397.         """
  1398.         # In Python < 2.3, the standard library does not have
  1399.         # tempfile.mkstemp(), and unfortunately, tempfile.mktemp() is
  1400.         # insecure. So, I create a non-world-writable temporary directory and
  1401.         # store the temporary file in this directory.
  1402.         try:
  1403.             # We want to ensure that f is already bound in the local
  1404.             # scope when the finally clause (see below) is executed
  1405.             f = 0
  1406.             tmp_dir = _create_temporary_directory()
  1407.             # If we are here, tmp_dir *is* created (no exception was raised),
  1408.             # so chances are great that os.rmdir(tmp_dir) will succeed (as
  1409.             # long as tmp_dir is empty).
  1410.             #
  1411.             # Don't move the _create_temporary_directory() call inside the
  1412.             # following try statement, otherwise the user will always see a
  1413.             # PythonDialogOSError instead of an
  1414.             # UnableToCreateTemporaryDirectory because whenever
  1415.             # UnableToCreateTemporaryDirectory is raised, the subsequent
  1416.             # os.rmdir(tmp_dir) is bound to fail.
  1417.             try:
  1418.                 fName = os.path.join(tmp_dir, "text")
  1419.                 # No race condition as with the deprecated tempfile.mktemp()
  1420.                 # since tmp_dir is not world-writable.
  1421.                 f = open(fName, "wb")
  1422.                 f.write(text)
  1423.                 f.close()
  1424.  
  1425.                 # Ask for an empty title unless otherwise specified
  1426.                 if not "title" in kwargs.keys():
  1427.                     kwargs["title"] = ""
  1428.  
  1429.                 return self._perform(*(["--textbox", fName, str(height), str(width)],),    **kwargs)[0]
  1430.             finally:
  1431.                 if type(f) == types.FileType:
  1432.                     f.close()           # Safe, even several times
  1433.                     os.unlink(fName)
  1434.                 os.rmdir(tmp_dir)
  1435.         except os.error, v:
  1436.             raise PythonDialogOSError(v.strerror)
  1437.         except IOError, v:
  1438.             raise PythonDialogIOError(v)
  1439.  
  1440.     def tailbox(self, filename, height=20, width=60, **kwargs):
  1441.         """Display the contents of a file in a dialog box, as in "tail -f".
  1442.  
  1443.         filename -- name of the file whose contents is to be
  1444.                     displayed in the box
  1445.         height   -- height of the box
  1446.         width    -- width of the box
  1447.  
  1448.         Display the contents of the specified file, updating the
  1449.         dialog box whenever the file grows, as with the "tail -f"
  1450.         command.
  1451.  
  1452.         Return the exit status (an integer) of the dialog-like
  1453.         program.
  1454.  
  1455.         Notable exceptions:
  1456.  
  1457.             any exception raised by self._perform()
  1458.  
  1459.         """
  1460.         return self._perform(*(["--tailbox", filename, str(height), str(width)],),**kwargs)[0]
  1461.         # No tailboxbg widget, at least for now.
  1462.  
  1463.     def textbox(self, filename, height=20, width=60, **kwargs):
  1464.         """Display the contents of a file in a dialog box.
  1465.  
  1466.         filename -- name of the file whose contents is to be
  1467.                     displayed in the box
  1468.         height   -- height of the box
  1469.         width    -- width of the box
  1470.  
  1471.         A text box lets you display the contents of a text file in a
  1472.         dialog box. It is like a simple text file viewer. The user
  1473.         can move through the file by using the UP/DOWN, PGUP/PGDN
  1474.         and HOME/END keys available on most keyboards. If the lines
  1475.         are too long to be displayed in the box, the LEFT/RIGHT keys
  1476.         can be used to scroll the text region horizontally. For more
  1477.         convenience, forward and backward searching functions are
  1478.         also provided.
  1479.  
  1480.         Return the exit status (an integer) of the dialog-like
  1481.         program.
  1482.  
  1483.         Notable exceptions:
  1484.  
  1485.             any exception raised by self._perform()
  1486.  
  1487.         """
  1488.         # This is for backward compatibility... not that it is
  1489.         # stupid, but I prefer explicit programming.
  1490.         if not "title" in kwargs.keys():
  1491.             kwargs["title"] = filename
  1492.         return self._perform(*(["--textbox", filename, str(height), str(width)],),**kwargs)[0]
  1493.  
  1494.     def timebox(self, text, height=3, width=30, hour=-1, minute=-1,
  1495.                 second=-1, **kwargs):
  1496.         """Display a time dialog box.
  1497.  
  1498.         text   -- text to display in the box
  1499.         height -- height of the box
  1500.         width  -- width of the box
  1501.         hour   -- inititial hour selected
  1502.         minute -- inititial minute selected
  1503.         second -- inititial second selected
  1504.         
  1505.         A dialog is displayed which allows you to select hour, minute
  1506.         and second. If the values for hour, minute or second are
  1507.         negative (or not explicitely provided, as they default to
  1508.         -1), the current time's corresponding values are used. You
  1509.         can increment or decrement any of those using the left-, up-,
  1510.         right- and down-arrows. Use tab or backtab to move between
  1511.         windows.
  1512.  
  1513.         Return a tuple of the form (code, time) where `code' is the
  1514.         exit status (an integer) of the dialog-like program and
  1515.         `time' is a list of the form [hour, minute, second] (where
  1516.         `hour', `minute' and `second' are integers corresponding to
  1517.         the time chosen by the user) if the box was closed with OK,
  1518.         or None if it was closed with the Cancel button.
  1519.  
  1520.         Notable exceptions:
  1521.             - any exception raised by self._perform()
  1522.             - PythonDialogReModuleError
  1523.             - UnexpectedDialogOutput
  1524.  
  1525.         """
  1526.         (code, output) = self._perform(*(["--timebox", text, str(height), str(width), str(hour), str(minute), str(second)],),**kwargs)
  1527.         if code == self.DIALOG_OK:
  1528.             try:
  1529.                 mo = _timebox_time_rec.match(output)
  1530.                 if mo is None:
  1531.                     raise UnexpectedDialogOutput(
  1532.                         "the dialog-like program returned the following "
  1533.                         "unexpected time with the --timebox option: %s" % output)
  1534.                 time = map(int, mo.group("hour", "minute", "second"))
  1535.             except re.error, v:
  1536.                 raise PythonDialogReModuleError(v)
  1537.         else:
  1538.             time = None
  1539.         return (code, time)
  1540.  
  1541.     def yesno(self, text, height=10, width=30, **kwargs):
  1542.         """Display a yes/no dialog box.
  1543.  
  1544.         text   -- text to display in the box
  1545.         height -- height of the box
  1546.         width  -- width of the box
  1547.  
  1548.         A yes/no dialog box of size `height' rows by `width' columns
  1549.         will be displayed. The string specified by `text' is
  1550.         displayed inside the dialog box. If this string is too long
  1551.         to fit in one line, it will be automatically divided into
  1552.         multiple lines at appropriate places. The text string can
  1553.         also contain the sub-string "\\n" or newline characters to
  1554.         control line breaking explicitly. This dialog box is useful
  1555.         for asking questions that require the user to answer either
  1556.         yes or no. The dialog box has a Yes button and a No button,
  1557.         in which the user can switch between by pressing the TAB
  1558.         key.
  1559.  
  1560.         Return the exit status (an integer) of the dialog-like
  1561.         program.
  1562.  
  1563.         Notable exceptions:
  1564.  
  1565.             any exception raised by self._perform()
  1566.  
  1567.         """
  1568.         return self._perform(*(["--yesno", text, str(height), str(width)],),**kwargs)[0]
  1569.